home *** CD-ROM | disk | FTP | other *** search
/ X User Tools / X User Tools (O'Reilly and Associates)(1994).ISO / sun4c / archive / tcltk.z / tcltk / man / catn / winfo.n < prev    next >
Text File  |  1994-09-20  |  13KB  |  331 lines
  1.  
  2.  
  3.  
  4. winfo(n)                   Tk Commands
  5.  
  6.  
  7.  
  8. _________________________________________________________________
  9.  
  10. NAME
  11.      winfo - Return window-related information
  12.  
  13. SYNOPSIS
  14.      winfo _o_p_t_i_o_n ?_a_r_g _a_r_g ...?
  15. _________________________________________________________________
  16.  
  17.  
  18. DESCRIPTION
  19.      The winfo command is used to retrieve information about win-
  20.      dows  managed  by  Tk.   It can take any of a number of dif-
  21.      ferent forms, depending on the _o_p_t_i_o_n argument.   The  legal
  22.      forms are:
  23.  
  24.      winfo atom _n_a_m_e
  25.           Returns a decimal string giving the integer  identifier  |
  26.           for  the  atom  whose  name is _n_a_m_e.  If no atom exists  |
  27.           with the name _n_a_m_e then a new one is created.            |
  28.  
  29.      winfo atomname _i_d                                                  ||
  30.           Returns  the  textual  name  for the atom whose integer  |
  31.           identifier is _i_d.  This command is the inverse  of  the  |
  32.           winfo atom command.  Generates an error if no such atom  |
  33.           exists.                                                  |
  34.  
  35.      winfo cells _w_i_n_d_o_w                                                 ||
  36.           Returns  a decimal string giving the number of cells in  |
  37.           the color map for _w_i_n_d_o_w.
  38.  
  39.      winfo children _w_i_n_d_o_w
  40.           Returns a list containing the path  names  of  all  the
  41.           children  of _w_i_n_d_o_w.  Top-level windows are returned as
  42.           children of their logical parents.
  43.  
  44.      winfo class _w_i_n_d_o_w
  45.           Returns the class name for _w_i_n_d_o_w.
  46.  
  47.      winfo containing _r_o_o_t_X _r_o_o_t_Y
  48.           Returns the path name for  the  window  containing  the  |
  49.           point  given  by  _r_o_o_t_X and _r_o_o_t_Y.  _R_o_o_t_X and _r_o_o_t_Y are  |
  50.           specified in screen units (i.e.  any form acceptable to  |
  51.           Tk_GetPixels) in the coordinate system of the root win-  |
  52.           dow (if a virtual-root window manager is  in  use  then  |
  53.           the  coordinate  system  of  the virtual root window is  |
  54.           used).  If no window in this application  contains  the  |
  55.           point  then  an empty string is returned.  In selecting  |
  56.           the containing window, children are given higher prior-  |
  57.           ity  than parents and among siblings the highest one in  |
  58.           the stacking order is chosen.                            |
  59.  
  60.  
  61.  
  62.  
  63. Tk                                                              1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. winfo(n)                   Tk Commands
  71.  
  72.  
  73.  
  74.      winfo depth _w_i_n_d_o_w                                                 ||
  75.           Returns  a  decimal  string  giving the depth of _w_i_n_d_o_w  |
  76.           (number of bits per pixel).                              |
  77.  
  78.      winfo exists _w_i_n_d_o_w                                                ||
  79.           Returns  1  if there exists a window named _w_i_n_d_o_w, 0 if  |
  80.           no such window exists.                                   |
  81.  
  82.      winfo fpixels _w_i_n_d_o_w _n_u_m_b_e_r                                        ||
  83.           Returns  a  floating-point  value  giving the number of  |
  84.           pixels in _w_i_n_d_o_w corresponding to the distance given by  |
  85.           _n_u_m_b_e_r.   _N_u_m_b_e_r  may  be specified in any of the forms  |
  86.           acceptable  to  Tk_GetScreenMM,  such  as  ``2.0c''  or  |
  87.           ``1i''.   The  return  value may be fractional;  for an  |
  88.           integer value, use winfo pixels.
  89.  
  90.      winfo geometry _w_i_n_d_o_w
  91.           Returns  the  geometry  for   _w_i_n_d_o_w,   in   the   form
  92.           _w_i_d_t_hx_h_e_i_g_h_t+_x+_y.  All dimensions are in pixels.
  93.  
  94.      winfo height _w_i_n_d_o_w
  95.           Returns a decimal string giving _w_i_n_d_o_w's height in pix-
  96.           els.  When a window is first created its height will be
  97.           1 pixel;  the height will eventually be  changed  by  a
  98.           geometry manager to fulfill the window's needs.  If you
  99.           need the  true  height  immediately  after  creating  a
  100.           widget,  invoke update to force the geometry manager to
  101.           arrange it, or use winfo reqheight to get the  window's
  102.           requested height instead of its actual height.
  103.  
  104.      winfo id _w_i_n_d_o_w
  105.           Returns a hexadecimal string indicating the X  identif-
  106.           ier for _w_i_n_d_o_w.
  107.  
  108.      winfo interps
  109.           Returns a list whose members are the names of  all  Tcl
  110.           interpreters (e.g. all Tk-based applications) currently
  111.           registered for the display of the invoking application.
  112.  
  113.      winfo ismapped _w_i_n_d_o_w
  114.           Returns 1 if _w_i_n_d_o_w is currently mapped, 0 otherwise.
  115.  
  116.      winfo name _w_i_n_d_o_w
  117.           Returns _w_i_n_d_o_w's name (i.e. its name within its parent,
  118.           as  opposed  to its full path name).  The command winfo  |
  119.           name . will return the name of the application.
  120.  
  121.      winfo parent _w_i_n_d_o_w
  122.           Returns the path name of _w_i_n_d_o_w's parent, or  an  empty
  123.           string if _w_i_n_d_o_w is the main window of the application.
  124.  
  125.      winfo pathname _i_d
  126.  
  127.  
  128.  
  129. Tk                                                              2
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. winfo(n)                   Tk Commands
  137.  
  138.  
  139.  
  140.           Returns the path name of the window whose X  identifier
  141.           is  _i_d.   _I_d  must  be a decimal, hexadecimal, or octal
  142.           integer and must correspond to a window in the invoking
  143.           application.
  144.  
  145.      winfo pixels _w_i_n_d_o_w _n_u_m_b_e_r
  146.           Returns the number of pixels in _w_i_n_d_o_w corresponding to  |
  147.           the  distance given by _n_u_m_b_e_r.  _N_u_m_b_e_r may be specified  |
  148.           in any of the forms acceptable to Tk_GetPixels, such as  |
  149.           ``2.0c''  or  ``1i''.   The  result  is  rounded to the  |
  150.           nearest integer value;  for a  fractional  result,  use  |
  151.           winfo fpixels.
  152.  
  153.      winfo reqheight _w_i_n_d_o_w
  154.           Returns a  decimal  string  giving  _w_i_n_d_o_w's  requested
  155.           height,  in pixels.  This is the value used by _w_i_n_d_o_w's
  156.           geometry manager to compute its geometry.
  157.  
  158.      winfo reqwidth _w_i_n_d_o_w
  159.           Returns a  decimal  string  giving  _w_i_n_d_o_w's  requested
  160.           width,  in  pixels.  This is the value used by _w_i_n_d_o_w's
  161.           geometry manager to compute its geometry.
  162.  
  163.      winfo rgb _w_i_n_d_o_w _c_o_l_o_r
  164.           Returns a list containing three decimal  values,  which  |
  165.           are   the   red,   green,  and  blue  intensities  that  |
  166.           correspond to _c_o_l_o_r in  the  window  given  by  _w_i_n_d_o_w.  |
  167.           _C_o_l_o_r  may  be specified in any of the forms acceptable  |
  168.           for a color option.
  169.  
  170.      winfo rootx _w_i_n_d_o_w
  171.           Returns a decimal string giving  the  x-coordinate,  in
  172.           the root window of the screen, of the upper-left corner
  173.           of _w_i_n_d_o_w's border (or _w_i_n_d_o_w if it has no border).
  174.  
  175.      winfo rooty _w_i_n_d_o_w
  176.           Returns a decimal string giving  the  y-coordinate,  in
  177.           the root window of the screen, of the upper-left corner
  178.           of _w_i_n_d_o_w's border (or _w_i_n_d_o_w if it has no border).
  179.  
  180.      winfo screen _w_i_n_d_o_w
  181.           Returns the name of the screen associated with  _w_i_n_d_o_w,
  182.           in the form _d_i_s_p_l_a_y_N_a_m_e._s_c_r_e_e_n_I_n_d_e_x.
  183.  
  184.      winfo screencells _w_i_n_d_o_w
  185.           Returns a decimal string giving the number of cells  in  |
  186.           the default color map for _w_i_n_d_o_w's screen.               |
  187.  
  188.      winfo screendepth _w_i_n_d_o_w                                           ||
  189.           Returns  a  decimal string giving the depth of the root  |
  190.           window of _w_i_n_d_o_w's screen (number of bits per pixel).    |
  191.  
  192.  
  193.  
  194.  
  195. Tk                                                              3
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. winfo(n)                   Tk Commands
  203.  
  204.  
  205.  
  206.      winfo screenheight _w_i_n_d_o_w                                          ||
  207.           Returns  a decimal string giving the height of _w_i_n_d_o_w's  |
  208.           screen, in pixels.                                       |
  209.  
  210.      winfo screenmmheight _w_i_n_d_o_w                                        ||
  211.           Returns  a decimal string giving the height of _w_i_n_d_o_w's  |
  212.           screen, in millimeters.                                  |
  213.  
  214.      winfo screenmmwidth _w_i_n_d_o_w                                         ||
  215.           Returns  a  decimal string giving the width of _w_i_n_d_o_w's  |
  216.           screen, in millimeters.                                  |
  217.  
  218.      winfo screenvisual _w_i_n_d_o_w                                          ||
  219.           Returns  one  of  the following strings to indicate the  |
  220.           default visual type for _w_i_n_d_o_w's  screen:  directcolor,  |
  221.           grayscale,  pseudocolor,  staticcolor,  staticgray,  or  |
  222.           truecolor.                                               |
  223.  
  224.      winfo screenwidth _w_i_n_d_o_w                                           ||
  225.           Returns  a  decimal string giving the width of _w_i_n_d_o_w's  |
  226.           screen, in pixels.                                       |
  227.  
  228.      winfo toplevel _w_i_n_d_o_w                                              ||
  229.           Returns  the path name of the top-level window contain-  |
  230.           ing _w_i_n_d_o_w.                                              |
  231.  
  232.      winfo visual _w_i_n_d_o_w                                                ||
  233.           Returns  one  of  the following strings to indicate the  |
  234.           visual type for _w_i_n_d_o_w: directcolor,  grayscale,  pseu-  |
  235.           docolor, staticcolor, staticgray, or truecolor.          |
  236.  
  237.      winfo vrootheight _w_i_n_d_o_w                                           ||
  238.           Returns  the  height of the virtual root window associ-  |
  239.           ated with _w_i_n_d_o_w if there is  one;   otherwise  returns  |
  240.           the height of _w_i_n_d_o_w's screen.                           |
  241.  
  242.      winfo vrootwidth _w_i_n_d_o_w                                            ||
  243.           Returns the width of the virtual root window associated  |
  244.           with _w_i_n_d_o_w if there is  one;   otherwise  returns  the  |
  245.           width of _w_i_n_d_o_w's screen.                                |
  246.  
  247.      winfo vrootx _w_i_n_d_o_w                                                ||
  248.           Returns the x-offset of the virtual root window associ-  |
  249.           ated with _w_i_n_d_o_w, relative to the root  window  of  its  |
  250.           screen.   This  is  normally  either  zero or negative.  |
  251.           Returns 0 if there is no virtual root window  for  _w_i_n_-  |
  252.           _d_o_w.                                                     |
  253.  
  254.      winfo vrooty _w_i_n_d_o_w                                                ||
  255.           Returns the y-offset of the virtual root window associ-  |
  256.           ated with _w_i_n_d_o_w, relative to the root  window  of  its  |
  257.           screen.   This  is  normally  either  zero or negative.  |
  258.  
  259.  
  260.  
  261. Tk                                                              4
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268. winfo(n)                   Tk Commands
  269.  
  270.  
  271.  
  272.           Returns 0 if there is no virtual root window  for  _w_i_n_-  |
  273.           _d_o_w.
  274.  
  275.      winfo width _w_i_n_d_o_w
  276.           Returns a decimal string giving _w_i_n_d_o_w's width in  pix-
  277.           els.   When a window is first created its width will be
  278.           1 pixel;  the width will eventually  be  changed  by  a
  279.           geometry manager to fulfill the window's needs.  If you
  280.           need  the  true  width  immediately  after  creating  a
  281.           widget,  invoke update to force the geometry manager to
  282.           arrange it, or use winfo reqwidth to get  the  window's
  283.           requested width instead of its actual width.
  284.  
  285.      winfo x _w_i_n_d_o_w
  286.           Returns a decimal string giving  the  x-coordinate,  in
  287.           _w_i_n_d_o_w's  parent,  of the upper-left corner of _w_i_n_d_o_w's
  288.           border (or _w_i_n_d_o_w if it has no border).
  289.  
  290.      winfo y _w_i_n_d_o_w
  291.           Returns a decimal string giving  the  y-coordinate,  in
  292.           _w_i_n_d_o_w's  parent,  of the upper-left corner of _w_i_n_d_o_w's
  293.           border (or _w_i_n_d_o_w if it has no border).
  294.  
  295.  
  296. KEYWORDS
  297.      atom, children, class, geometry, height, identifier,  infor-
  298.      mation,  interpreters,  mapped,  parent,  path name, screen,
  299.      virtual root, width, window
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327. Tk                                                              5
  328.  
  329.  
  330.  
  331.